/*
 * Copyright (c) 2011 Junichiro Okuno
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of Junichiro Okuno.
 */

package tcp_net;

import tcp_net.debug.DebugInfo;
import java.util.List;
import java.util.ArrayList;

/**
	This class provides a functionality to process the message to Server class
	@author J. Okuno
*/
public abstract class MessageProcessor implements Context
{
	/**
		Debug information
	*/
	private final static boolean DEBUG = DebugInfo.MESSAGE_PROCESSOR_DEBUG;
	
	/**
		State object
	*/
	protected State state;
	
	/**
		Command analyser for a message processing
	*/
	protected CommandAnalyser analyser;
	
	/**
		Command object for an execution
	*/
	protected Command command;
	
	/**
		A list of string texts to store the processed results
	*/
	protected List<String> output_lines;
	
	/**
		Server's handler
	*/
	protected Handler handler;
	
	
	/**
		Init the message processor
		@param hd a server handler 
	*/
	public MessageProcessor(Handler hd)
	{
		analyser = new CommandAnalyser();
		output_lines = new ArrayList<String>();
		
		handler = hd;
		DebugInfo.print(DEBUG,"MessageProcessor created.");
	}

	/**
		This method changes a state from prevoiously assigned one
		@param st a new state
	*/
	public void changeState(State st)
	{
		DebugInfo.print(DEBUG,"State changed");
		
		state = st;
	}
	
	/**
		This method returns a handler 
		@return a handler
	*/	
	public Handler getHandler() { return handler; }
	
	/**
		This method processes the message and converts to a list of responses
		@param message a command with its argument
		@return a list of reponses
	*/
	public abstract List<String> process(String message);
}